<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Class: Roomer::Generators::InstallGenerator
  
    &mdash; Documentation by YARD 0.7.2
  
</title>

  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  relpath = '../..';
  if (relpath != '') relpath += '/';
</script>

  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


  </head>
  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>
    
    <div id="header">
      <div id="menu">
  
    <a href="../../_index.html">Index (I)</a> &raquo; 
    <span class='title'><span class='object_link'><a href="../../Roomer.html" title="Roomer (module)">Roomer</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Generators.html" title="Roomer::Generators (module)">Generators</a></span></span>
     &raquo; 
    <span class="title">InstallGenerator</span>
  
  
  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a id="class_list_link" href="#">Class List</a>
  
    <a id="method_list_link" href="#">Method List</a>
  
    <a id="file_list_link" href="#">File List</a>
  
</div>
      <div class="clear"></div>
    </div>
    
    <iframe id="search_frame"></iframe>
    
    <div id="content"><h1>Class: Roomer::Generators::InstallGenerator
  
  
  
</h1>

<dl class="box">
  
    <dt class="r1">Inherits:</dt>
    <dd class="r1">
      <span class="inheritName">Rails::Generators::Base</span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next">Rails::Generators::Base</li>
          
            <li class="next">Roomer::Generators::InstallGenerator</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
      </dd>
    
  
  
    
  
    
  
  
  
    <dt class="r2 last">Defined in:</dt>
    <dd class="r2 last">lib/generators/install/install_generator.rb</dd>
  
</dl>
<div class="clear"></div>



  


  

  
    <h2>
      Instance Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#copy_initializer-instance_method" title="#copy_initializer (instance method)">- (Object) <strong>copy_initializer</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Generates the Initializer under config/initializers/roomer.rb.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#shared_schema_name-instance_method" title="#shared_schema_name (instance method)">- (Symbol) <strong>shared_schema_name</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Reads the shared-schema-name and assigns it to Roomer.shared_schema_name.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#show_readme-instance_method" title="#show_readme (instance method)">- (Object) <strong>show_readme</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Displays the instructions for setting up Roomer.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#tenants_table-instance_method" title="#tenants_table (instance method)">- (Symbol) <strong>tenants_table</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Reads the tenants-table option and assigns it to Roomer.tenants_table
config parameter.</p>
</div></span>
  
</li>

      
    </ul>
  


  

  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>
    
    
      <div class="method_details first">
  <p class="signature first" id="copy_initializer-instance_method">
  
    - (<tt>Object</tt>) <strong>copy_initializer</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Generates the Initializer under config/initializers/roomer.rb</p>


  </div>
</div>
<div class="tags">
  
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


28
29
30</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/generators/install/install_generator.rb', line 28</span>

<span class='def def kw'>def</span> <span class='copy_initializer identifier id'>copy_initializer</span>
  <span class='template identifier id'>template</span> <span class='string val'>&quot;roomer.rb&quot;</span><span class='comma token'>,</span> <span class='string val'>&quot;config/initializers/roomer.rb&quot;</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="shared_schema_name-instance_method">
  
    - (<tt>Symbol</tt>) <strong>shared_schema_name</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Reads the shared-schema-name and assigns it to Roomer.shared_schema_name</p>


  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Symbol</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>
<p>shared schema name</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


23
24
25</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/generators/install/install_generator.rb', line 23</span>

<span class='def def kw'>def</span> <span class='shared_schema_name identifier id'>shared_schema_name</span>
  <span class='Roomer constant id'>Roomer</span><span class='dot token'>.</span><span class='shared_schema_name identifier id'>shared_schema_name</span> <span class='opasgn op'>||=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:shared_schema_name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='tableize identifier id'>tableize</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="show_readme-instance_method">
  
    - (<tt>Object</tt>) <strong>show_readme</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Displays the instructions for setting up Roomer</p>


  </div>
</div>
<div class="tags">
  
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


33
34
35</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/generators/install/install_generator.rb', line 33</span>

<span class='def def kw'>def</span> <span class='show_readme identifier id'>show_readme</span>
  <span class='readme identifier id'>readme</span> <span class='string val'>&quot;README&quot;</span> <span class='if if_mod kw'>if</span> <span class='behavior identifier id'>behavior</span> <span class='eq op'>==</span> <span class='symbol val'>:invoke</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="tenants_table-instance_method">
  
    - (<tt>Symbol</tt>) <strong>tenants_table</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Reads the tenants-table option and assigns it to Roomer.tenants_table
config parameter</p>


  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Symbol</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>
<p>tenants table name</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


17
18
19</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/generators/install/install_generator.rb', line 17</span>

<span class='def def kw'>def</span> <span class='tenants_table identifier id'>tenants_table</span>
  <span class='Roomer constant id'>Roomer</span><span class='dot token'>.</span><span class='tenants_table identifier id'>tenants_table</span> <span class='opasgn op'>||=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:tenants_table</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='tableize identifier id'>tableize</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>
    
    <div id="footer">
  Generated on Fri Aug 12 10:39:12 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.2 (ruby-1.8.7).
</div>

  </body>
</html>